Microsoft Cognitive Language Service - Analyze Conversations (preview:2022-10-01)

2025/07/24 • 4 deleted methods

ConversationAnalysis_AnalyzeConversation (removed)
Description :  Analyzes the input conversation utterance.
Reference :  Link ¶

⚼ Request

POST:  /:analyze-conversations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
body:
{
Description: A single conversation task to execute. ,
Required: True ,
}
{
kind:
{
Description: Enumeration of supported conversation tasks. ,
Enum:
{
Conversation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Enumeration of supported conversation task results. ,
Enum:
{
ConversationResult: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for the specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AnalyzeConversation_SubmitJob (removed)
Description :  Submit a collection of conversations for analysis. Specify one or more unique tasks to be executed.
Reference :  Link ¶

⚼ Request

POST:  /analyze-conversations/jobs
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
body:
{
Description: Collection of conversations to analyze and one or more tasks to execute. ,
Required: True ,
}
{
displayName:
{
Description: Display name for the analysis job. ,
Required: False ,
}
string ,
analysisInput:
{
Required: True ,
}
{
conversations:
{
Required: True ,
}
[
{
id:
{
Description: Unique identifier for the conversation. ,
Required: True ,
}
string ,
language:
{
Description: Language of the conversation item in BCP-47 format. ,
Required: True ,
}
string ,
modality:
{
Description: Enumeration of supported conversational modalities. ,
Enum:
{
transcript: No description available. ,
text: No description available. ,
}
,
Required: True ,
}
enum ,
domain:
{
Description: Enumeration of supported conversational domains. ,
Enum:
{
finance: No description available. ,
healthcare: No description available. ,
generic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
tasks:
{
Description: Set of tasks to execute on the input conversation. ,
Required: True ,
}
[
{
kind:
{
Description: Enumeration of supported analysis tasks on a collection of conversations. ,
Enum:
{
ConversationalPIITask: No description available. ,
ConversationalSummarizationTask: No description available. ,
ConversationalSentimentTask: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
AnalyzeConversation_JobStatus (removed)
Description :  Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.
Reference :  Link ¶

⚼ Request

GET:  /analyze-conversations/jobs/{jobId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
jobId:
{
Description: Job ID ,
Format: uuid ,
Required: True ,
}
string ,
showStats:
{
Description: (Optional) if set to true, response will contain request and document level statistics. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema:
{
Description: Contains the status of the submitted job for analyzing a conversation, along with related statistics. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
AnalyzeConversation_CancelJob (removed)
Description :  Cancel a long-running job for text analysis of conversations.
Reference :  Link ¶

⚼ Request

POST:  /analyze-conversations/jobs/{jobId}:cancel
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
jobId:
{
Description: Job ID ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
TooManyRequests: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
Timeout: No description available. ,
QuotaExceeded: No description available. ,
Conflict: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}